Checking the System's Health

While a PrizmDoc server does its best to keep itself up and running, it is possible for a PrizmDoc server to become unhealthy, in which case you must restart PrizmDoc (typically by rebooting the server).

To check whether or not a server is healthy, simply send an HTTP GET request to /PCCIS/V1/Service/Current/Health. If the server is healthy, HTTP 200 will be returned; if unhealthy, HTTP 500 will be returned. Note that if PrizmDoc has just started, HTTP 500 may be returned for a short time until the system has completely started up.

Multi-Server Mode: Use the CEP

If you are running in multi-server mode, send your request to the Cloud Entry Point (CEP), typically running on port 18682:

Example	Copy Code
GET server:18682/PCCIS/V1/Service/Current/Health

Single-Server Mode: Use the SEP

If you are running in single-server mode, send your request to the Server Entry Point (SEP), typically running on port 18681:

Example	Copy Code
GET server:18681/PCCIS/V1/Service/Current/Health

HTTP Response

HTTP 200 - Server is healthy and running normally.
HTTP 500 - Server is unhealthy and must be restarted (or PrizmDoc is still starting up).

Additional Information

Refer to the API topic, Health Status for more information on checking the health of PrizmDoc Server.